This repository provides two collections of Postman, one follows API Reference, the other follows Tutorials of Model Coordination API.
Postman is a popular tool that provides an easy-to-use interface to send HTTP requests. Postman is able to parse the responses that Forge sends you and save response parameter values to variables. These parameters can then be reused in subsequent requests through these variables. The Postman collections in this repository use this ability to provide pre-populated HTTP requests to help you follow the tutorial workflow with minimal effort. You can also modify the requests and experiment without having to write a single line of code.
-
You can learn how to install and use Postman from here.
-
You can download the Postman installer from here.
-
Clone this project or download it. It's recommended to install GitHub desktop. To clone it via command line, use the following (Terminal on MacOSX/Linux, Git Shell on Windows):
git clone https://github.com/xiaodongliang/bim360-mcapi-postman.test -
To play API endpoints, find collection and environment variables in API Reference, and import them to Postman. Next, check Readme of API Reference for detailed steps.
-
To play Tutorials, find collection and environment variables in Tutorials, and import them to Postman. Next, check Readme of API Reference for detailed steps.
- Model Coordination API requires to work with 3-legged token. This collection takes Inheriting auth to apply 3-legged token to every endpoint in the collection, which means it does not need to input the token in the header explicitly.
- The repository provides some test models at Models.
- In each collection or collection folder, some comments are enclosed for reference.
This sample is licensed under the terms of the MIT License. Please see the LICENSE file for full details.
Xiaodong Liang @coldwood, Forge Partner Development